[DOCS] Document dimension mapping parameter#75414
[DOCS] Document dimension mapping parameter#75414jrodewig merged 1 commit intoelastic:masterfrom jrodewig:docs__add-dimension-mapping-param-docs
Conversation
jrodewig
changed the title
jrodewig
changed the title
Changes: * Documents the `dimension` mapping parameter for `ip`, `keyword`, and `numeric` fields. * Documents the `index.mapping.dimension_fields.limit` index setting.
|
Hi @csoulios. During a recent meeting, the team agreed to re-add these docs. Let me know what you think. Thanks! |
jrodewig
added
:StorageEngine/TSDB
|
Pinging @elastic/es-docs (Team:Docs) |
elasticmachine
added
the
Team:Analytics
|
Pinging @elastic/es-analytics-geo (Team:Analytics) |
|
Thanks @csoulios! |
…5475) Changes: * Documents the `dimension` mapping parameter for `ip`, `keyword`, and `numeric` fields. * Documents the `index.mapping.dimension_fields.limit` index setting. # Conflicts: # docs/reference/mapping/types/ip.asciidoc # docs/reference/mapping/types/keyword.asciidoc # docs/reference/mapping/types/numeric.asciidoc
|
|
||
| [[index-mapping-dimension-fields-limit]] | ||
| `index.mapping.dimension_fields.limit`:: | ||
| For internal use by {kib} only. Maximum number of time series dimensions for the |
There was a problem hiding this comment.
I don't understand how it relates to Kibana?
There was a problem hiding this comment.
We previously discussed marking the dimension parameter (and by extension this setting) for internal use by the Elastic Observability (specifically metrics) solution only. That solution is shipped as a part of Kibana.
If that's changed, let me know. I can update this in a separate PR. Thanks!
There was a problem hiding this comment.
Thanks for the context. My understanding is that this was indeed the initial vision, but that we moved from per-field metadata to dedicated mapping parameters with the vision that these parameters would be used by Elasticsearch in the long term as well. E.g. rollups could auto-configure based on what fields are marked as dimensions, and the timeseries_mode setting could be computed automatically based on dimensions. None of these have been merged yet but hopefully this dimension flag is going to be used by more than Kibana in the near future. @csoulios Please keep me honest if the above is incorrect.
There was a problem hiding this comment.
@jpountz your understanding is correct. dimension and metric mapping parameters will be used by ES (both for TSDB and rollups) for discovering dimensions and metrics. Eventually, they will be available to end-users too.
It's only that at this point we want to keep this feature for internal use only until we feel confident there will be no changes required. See comment: #74450 (review)
There was a problem hiding this comment.
Thanks for the discussion. That aligns with my understanding. The important point is that end users should not be using the dimension parameter at this time.
I'll push a change to broaden the copy to "For internal use by Elastic only."
Changes: * Documents the `dimension` mapping parameter for `ip`, `keyword`, and `numeric` fields. * Documents the `index.mapping.dimension_fields.limit` index setting.
6 participants
Changes:
Documents the
dimensionmapping parameter forip,keyword, andnumericfields.
Documents the
index.mapping.dimension_fields.limitindex setting.Relates to #74450 and #74939
Previews
ipfield type: https://elasticsearch_75414.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/ip.html#ip-paramskeywordfield type: https://elasticsearch_75414.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/keyword.html#keyword-paramsnumericfield types: https://elasticsearch_75414.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/number.html#number-params